﻿#region Header
// ------------------------ Licence / Copyright ------------------------
// 
// ScrumTable for Scrum Meeting Support
// Copyright © HSR - Hochschule für Technik Rapperswil
// All Rights Reserved
// 
// Author:
//  Michael Gfeller Silvan Gehrig Patrick Boos
// 
// ---------------------------------------------------------------------
#endregion

#region Usings

using System;

#endregion


namespace ScrumTable.DL.Data.Generic.Cache
{
    /// <summary>
    /// This class represents the base interface for all tfs elements.
    /// </summary>
    public interface ICacheIdentity
    {
        #region Properties
        //--------------------------------------------------------------------
        // Properties
        //--------------------------------------------------------------------

        /// <summary>
        /// Gets the tfs id of the element. Caution: This id is unique in
        /// the current storage only.
        /// </summary>
        int Id { get; }

        /// <summary>
        /// Returns true if the current element contains has an id assigned.
        /// </summary>
        bool HasId { get; }

        /// <summary>
        /// Gets the global unqiue id of the tfs element.
        /// </summary>
        string UniqueId { get; }

        /// <summary>
        /// Gets the revision (server side versioning information) of the current element.
        /// </summary>
        int Revision { get; }

        /// <summary>
        /// Gets the identity category (element type).
        /// </summary>
        string Category { get; }

        #endregion

        #region Methods
        //--------------------------------------------------------------------
        // Methods
        //--------------------------------------------------------------------

        #endregion

        #region Events

        //--------------------------------------------------------------------
        // Events
        //--------------------------------------------------------------------

        #endregion
    }
}